Improve examples in docs #16
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* fix types and remove non-existing function * fix tests * fix color band range * increment patch number * fix range and tests * changelog * bring back function * more tests * missing include * typo * better docstrings * correctness * ws
There was a problem hiding this comment.
Pull Request Overview
This pull request enhances the documentation with comprehensive Moldflow API examples and adds flexibility to the publishing workflow. The changes provide practical code examples for advanced Moldflow operations while allowing documentation-only releases.
- Added extensive advanced examples covering data transformation, diagnostics, boundary conditions, and PowerPoint report generation
- Modified the GitHub Actions workflow to support documentation-only publishing
- Enhanced the documentation with real-world use cases and complex API interactions
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/source/readme.rst | Added comprehensive advanced examples including derived results, vector operations, coolant endpoints, and PowerPoint report generation |
| .github/workflows/publish.yml | Added docs_only input parameter and conditional logic to skip package publishing steps when only updating documentation |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
sankalps0549
reviewed
Oct 7, 2025
LiawChungYao
reviewed
Oct 9, 2025
docs/source/readme.rst
Outdated
Comment on lines
1062
to
1065
| # If capture produced an unexpectedly small file, fallback attempt with result=False | ||
| try: | ||
| if os.path.getsize(tmp.name) < 12000 and plot is not None: | ||
| # Fallback: capture without result overlay in case the plot layer isn't rendering |
There was a problem hiding this comment.
Are these comments verified because the people who are analyzing the sample will be carefully going through these
LiawChungYao
approved these changes
Oct 9, 2025
osinjoku
added a commit
that referenced
this pull request
Oct 9, 2025
* Fix return types and color band range (#5) * fix types and remove non-existing function * fix tests * fix color band range * increment patch number * fix range and tests * changelog * bring back function * more tests * missing include * typo * better docstrings * correctness * ws * docs only publish * more examples * point to pypi (#3) * remove multi-statement lines * remove vb references * better explanation * simpler * cleanup and make sure the scripts work * Update readme.rst * remove unnecessary fallback
osinjoku
added a commit
that referenced
this pull request
Oct 10, 2025
* Improve examples in docs (#16) * Fix return types and color band range (#5) * fix types and remove non-existing function * fix tests * fix color band range * increment patch number * fix range and tests * changelog * bring back function * more tests * missing include * typo * better docstrings * correctness * ws * docs only publish * more examples * point to pypi (#3) * remove multi-statement lines * remove vb references * better explanation * simpler * cleanup and make sure the scripts work * Update readme.rst * remove unnecessary fallback * Add convenience message boxes and input dialogs via Win32 (#15) * progress * order * allow ok for localisation * add integration test * format * lint * fix test * working * lint * i18n * format * lint * fnish lint * review * placement * omit test coverage for win32 ui heavy class * add to changelog * fix coverage * more friendly win32 error handling * Update src/moldflow/message_box.py Co-authored-by: Sankalp Shrivastava <[email protected]> --------- Co-authored-by: Sankalp Shrivastava <[email protected]> * Improve MessageBox documentation (#21) * progress * order * allow ok for localisation * add integration test * format * lint * fix test * working * lint * i18n * format * lint * fnish lint * review * placement * omit test coverage for win32 ui heavy class * add to changelog * fix coverage * more friendly win32 error handling * Update src/moldflow/message_box.py Co-authored-by: Sankalp Shrivastava <[email protected]> * better doc --------- Co-authored-by: Sankalp Shrivastava <[email protected]> * bump version * update changelog --------- Co-authored-by: Sankalp Shrivastava <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Add more examples in docs (including PowerPoint generation) and allow deploying docs without trying to push to PyPI.
Fixes # N/A.
Type of change
Please delete options that are not relevant.
Checklist
Please delete options that are not relevant.
Testing
Tested new examples locally.
Additional Notes
Add any other context about the pull request here.